<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>oak-block-account: openark kit documentation</title>
	<meta name="description" content="oak-block-account: openark kit" />
	<meta name="keywords" content="oak-block-account: openark kit" />
	<link rel="stylesheet" type="text/css" href="style.css" />
</head>

<body>
	<div id="main">
		<div id="header">
			<h1>openark kit documentation</h1>
			<div class="subtitle">Common utilities for MySQL</div>
		</div>
		<div id="contentwrapper">
			<div id="content">
				<h2><a href="oak-block-account.html">oak-block-account</a></h2>	
<h3>NAME</h3>
oak-block-account: block or release MySQL users accounts, disabling them or enabling them to login
<h3>SYNOPSIS</h3>
Disable the user web@webhost1.com from logging into MySQL:
<blockquote>oak-block-account --block --account-user=web --account-host=webhost1.com</blockquote>
Re-enable the user web@webhost1.com to log into MySQL:
<blockquote>oak-block-account --release --account-user=web --account-host=webhost1.com</blockquote>
Disable the user 'web' on any host from logging into MySQL:
<blockquote>oak-block-account --block --account-user=web</blockquote>
Disable the user 'web' on any host from logging into MySQL, and kill any existing connection for that user:
<blockquote>oak-block-account --block --account-user=web --kill</blockquote>
Same as above, provide connection parameters, prompt for password:
<blockquote>oak-block-account --user=root --ask-pass --socket=/tmp/mysql.sock -b --account-user=web</blockquote>
Same as above, use defaults file:
<blockquote>oak-block-account --defaults-file=/home/myuser/.my-oak.cnf -b --account-user=web</blockquote>
<h3>DESCRIPTION</h3>
<p>
A long time missing functionality from MySQL is the ability to temporarily block connections for specific accounts, without changing their security privileges.
</p>

<p><i>oak-block-account</i> addresses this issue by utilizing the way MySQL passwords are stored. Essentially, to block an account, this tool changes the account's password into a blocked-password value in such way that:</p>

<ul>
	<li>It is impossible to log in to the account with the original password</li>
	<li>It is impossible to log in to the account with any other password</li>
	<li>It is possible to detect that the password is a blocked-password</li>
	<li>It is possible to recover the original password</li>
</ul>
<p>When a "release" action is requested, oak-block-account checks on the current password. If it identifies it as a blocked-password, it re institutes the original password.
In both cases the tool utilizes the SET PASSWORD command. The  required privilege is an UPDATE on the mysql.user table, usually reserved to the `root` user.
</p>

<p>Connections which are open at the time of executing <i>oak-block-account</i> are unaffected.
</p>

<p>
Either --block, --release or --list must be specified.
</p>

<h3>OPTIONS</h3>
--account-user=ACCOUNT_USER
<p class="indent">Mandatory: the user (login) name to block/release</p>

--account-host=ACCOUNT_HOST
<p class="indent">The account's host. Leave blank to apply for all hosts</p>

--ask-pass
<p class="indent">Prompt for password.</p>

-b, --block
<p class="indent">Block the specified account. If the account is already block nothing will change.</p>

--defaults-file=DEFAULTS_FILE
<p class="indent">Read from MySQL configuration file. Overrides --user, --password, --socket, --port.</p>
<p class="indent">Configuration needs to be in the following format:</p>

--block
<p class="indent">Print debug messages</p>

<p class="indent"><strong>[client]<br/>
user=my_user<br/>
password=my_pass<br/>
socket=/tmp/mysql.sock<br/>
port=3306</strong>
</p>

-H HOST, --host=HOST
<p class="indent">MySQL host (default: localhost)</p>

-l, --list
<p class="indent">List accounts and their status (blocked/released).</p>

-k, --kill
<p class="indent">(With --block) kill any existing connection for the blocked account.</p>

-p PASSWORD, --password=PASSWORD
<p class="indent">MySQL password</p>

-P PORT, --port=PORT
<p class="indent">TCP/IP port (default: 3306)</p>

--print-only
<p class="indent">Do not execute. Only print statement</p>

-r, --release
<p class="indent">Release a blocked account. If the account is not blocked nothing will change.</p>

-S SOCKET, --socket=SOCKET
<p class="indent">MySQL socket file. Only applies when host is localhost</p>

-u USER, --user=USER
<p class="indent">MySQL user</p>

-v, --verbose
<p class="indent">Print user friendly messages</p>

<h3>ENVIRONMENT</h3>
Requires MySQL 5.0 or newer, python 2.3 or newer.

python-mysqldb must be installed in order to use this tool. You can
<blockquote>apt-get install python-mysqldb</blockquote>
or
<blockquote>yum install mysql-python</blockquote>
<h3>SEE ALSO</h3>
<p>oak-kill-slow-queries</p>
<p>oak-security-audit</p>

<h3>LICENSE</h3>
This tool is released under the BSD license.
<blockquote><pre>Copyright (c) 2008 - 2010, Shlomi Noach
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</pre>
</blockquote>
<h3>AUTHOR</h3>
Shlomi Noach
				<br/>
			</div>
			<div id="sidebarwrapper">
				<div id="menu">
					<h3>openark kit tools</h3>
					<ul>
						<li><a title="Introduction" href="introduction.html">Introduction</a></li>
						<li><a title="Download" href="download.html">Download</a></li>
						<li><a title="Install" href="install.html">Install</a></li>
						<li><a title="oak-apply-ri" href="oak-apply-ri.html">oak-apply-ri</a></li>
						<li><a title="oak-block-account" href="oak-block-account.html">oak-block-account</a></li>
						<li><a title="oak-chunk-update" href="oak-chunk-update.html">oak-chunk-update</a></li>
						<li><a title="oak-get-slave-lag" href="oak-get-slave-lag.html">oak-get-slave-lag</a></li>
						<li><a title="oak-hook-general-log" href="oak-hook-general-log.html">oak-hook-general-log</a></li>
						<li><a title="oak-kill-slow-queries" href="oak-kill-slow-queries.html">oak-kill-slow-queries</a></li>
						<li><a title="oak-modify-charset" href="oak-modify-charset.html">oak-modify-charset</a></li>
						<li><a title="oak-online-alter-table" href="oak-online-alter-table.html">oak-online-alter-table</a></li>
						<li><a title="oak-prepare-shutdown" href="oak-prepare-shutdown.html">oak-prepare-shutdown</a></li>
						<li><a title="oak-purge-master-logs" href="oak-purge-master-logs.html">oak-purge-master-logs</a></li>
						<li><a title="oak-repeat-query" href="oak-repeat-query.html">oak-repeat-query</a></li>
						<li><a title="oak-security-audit" href="oak-security-audit.html">oak-security-audit</a></li>
						<li><a title="oak-show-limits" href="oak-show-limits.html">oak-show-limits</a></li>
						<li><a title="oak-show-replication-status" href="oak-show-replication-status.html">oak-show-replication-status</a></li>
					</ul>
				</div>
			</div>	
			<div class="clear">&nbsp;</div>
			
			<div id="footnote" align="center">
				<a href="">openark kit</a> documentation
			</div>
		</div>
	</div>
</body>
</html>
